home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audiofile / AFclosefile.z / AFclosefile
Encoding:
Text File  |  2002-10-03  |  3.5 KB  |  67 lines
  1.  
  2.  
  3.  
  4. aaaaffffCCCClllloooosssseeeeFFFFiiiilllleeee((((3333ddddmmmm))))                                              aaaaffffCCCClllloooosssseeeeFFFFiiiilllleeee((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      afCloseFile - close an audio file, update file header if file was opened
  10.      for write access.
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiiooooffffiiiilllleeee....hhhh>>>>
  14.  
  15.      iiiinnnntttt aaaaffffCCCClllloooosssseeeeFFFFiiiilllleeee((((AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee ffffiiiilllleeee))))
  16.  
  17. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  18.      _f_i_l_e   is the AAAAFFFFffffiiiilllleeeehhhhaaaannnnddddlllleeee structure for the audio file you want to
  19.             close.  This structure is the returned value of the
  20.             aaaaffffOOOOppppeeeennnnFFFFiiiilllleeee(3dm) call.
  21.  
  22. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  23.      aaaaffffCCCClllloooosssseeeeFFFFiiiilllleeee(((()))) returns 0 if _f_i_l_e is closed without error.  If an error
  24.      occurs while closing _f_i_l_e or updating the file header fields, it returns
  25.      -1.
  26.  
  27. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  28.      aaaaffffCCCClllloooosssseeeeFFFFiiiilllleeee(((()))) releases _f_i_l_e's resources back to the system.  This routine
  29.      also takes care of updating the header information for files which were
  30.      opened for write access.  Since _f_i_l_e will be deallocated, _f_i_l_e's value
  31.      should not be used in any subsequent Audiofile Library procedure calls.
  32.  
  33. CCCCAAAAVVVVEEEEAAAATTTTSSSS
  34.      Note that aaaaffffCCCClllloooosssseeeeFFFFiiiilllleeee(((()))) will close the file descriptor associated with
  35.      _f_i_l_e whether it was opened with aaaaffffOOOOppppeeeennnnFFFFiiiilllleeee(3dm) or aaaaffffOOOOppppeeeennnnFFFFDDDD(3dm).  This
  36.      is unfortunately not consistent with the SGI Movie Library, but must be
  37.      maintained for backwards compatibility.
  38.  
  39.      This routine will not function correctly if the user changes the file
  40.      position on the file descriptor for the AFfilehandle being manipulated.
  41.      See the section _C_A_V_E_A_T_S _F_O_R _U_S_I_N_G _T_H_E _H_A_N_D_L_E'_S _F_I_L_E _D_E_S_C_R_I_P_T_O_R in
  42.      aaaaffffIIIInnnnttttrrrroooo(3dm) for important information about how to deal with this
  43.      situation.
  44.  
  45. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  46.      aaaaffffSSSSyyyynnnnccccFFFFiiiilllleeee(3dm), aaaaffffOOOOppppeeeennnnFFFFiiiilllleeee(3dm), aaaaffffNNNNeeeewwwwFFFFiiiilllleeeeSSSSeeeettttuuuupppp(3dm),
  47.      aaaaffffFFFFrrrreeeeeeeeFFFFiiiilllleeeeSSSSeeeettttuuuupppp(3dm)
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.